Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSON schemas for data objects #756

Merged
merged 85 commits into from
Oct 17, 2023
Merged

JSON schemas for data objects #756

merged 85 commits into from
Oct 17, 2023

Conversation

johnbillion
Copy link
Owner

@johnbillion johnbillion commented Apr 15, 2023 •
edited
Loading

Maintaining the TypeScript interfaces separately from the PHP DTOs is risky as they may diverge.

This introduces a JSON schema for each DTO which used as the source of truth. These are then used to build the TypeScript interfaces used for the panel component props and to build the PHP DTO classes. As a bonus we also have usable JSON schemas for the data.

To build the interfaces and PHP classes:

npm run build-schemas

Progress

  • admin
  • assets
  • block_editor
  • cache
  • caps
  • conditionals
  • db_callers
  • db_components
  • db_dupes
  • db_queries
  • doing_it_wrong
  • environment
  • hooks
  • http
  • languages
  • logger
  • multisite
  • overview
  • php_errors
  • raw_request
  • redirects
  • request
  • theme
  • timing
  • transients

@johnbillion johnbillion marked this pull request as draft April 15, 2023 23:52
@johnbillion
Update the banner comment.
17e25c7
@johnbillion
Make more use of recursive calls for type resolution.
441564b
@johnbillion
Add a schema for user capability checks.
4463c76
@johnbillion
Add a schema for conditionals.
997a80e
@johnbillion
Add a schema for database query callers.
359020d
@johnbillion
Add a schema for database query components.
d328682
@johnbillion
Add a schema for duplicate database queries.
6d3c2bb
@johnbillion
Add a schema for database queries.
f767ff6
@johnbillion
I'll come back to this.
99cc8b8
@johnbillion
Fix the multiple type listings.
6382d32
@johnbillion
Implement the indentation.
113a4ac
@johnbillion
Add a schema for the environment.
2864709
@johnbillion
More adjustments.
7a056e5
@johnbillion
Update the Environment panel.
db97b30
@johnbillion
More updates to the Environment panel.
28064a5
@johnbillion
Add a missing field.
e71078a
@johnbillion
Add a schema for hooks.
faff431
@johnbillion
This doesn't have additional properties.
6c27232
@johnbillion
Add a schema for HTTP API requests.
9ab2f31
@johnbillion
Improve the int/float handling.
1208d08
@johnbillion
Improve this header.
71f1a11
@johnbillion
Support for enums.
ae58ecd
@johnbillion
Add a schema for languages.
2f19346
@johnbillion
Add a schema for the logger.
01507d3
@johnbillion
More structure for PHP error data.
360f380
@johnbillion
This is a frame item.
1b9b551
@johnbillion
These custom notations should take preference.
50d1ca6
@johnbillion
Merge branch 'client-side-rendering' into json-schemas
cae57c7 
# Conflicts:
#	collectors/http.php
#	data/http.php
#	package.json
@johnbillion
This is no longer present.
65266e3
@johnbillion
Move everything in the schema up a level and add the abstract data cl…
889159b 
…ass properties.
@johnbillion
Get more specific with the shape of database query data.
85a2c03
@johnbillion
Merge branch 'client-side-rendering' into json-schemas
03b0a6d 
# Conflicts:
#	collectors/block_editor.php
#	data/db_queries.php
@johnbillion
This is a return tag.
ce07082
@johnbillion
Add a schema for the Doing it Wrong data.
76b17d7
@johnbillion
Update schemas with recent changes in the develop branch.
77ca171
@johnbillion
Everything is legacy.
ab6a26a
@johnbillion
Fix the type for the missing dependencies list.
39f7c9f
@johnbillion
Be more strict about these inline type declarations.
04cb398
@johnbillion
This has a known shape now.
2ba4da0
@johnbillion
Document the globals.
b5a1d84
@johnbillion
Fix the multisite data structure.
6b44575
@johnbillion
Reference the source schema in generated DTOs.
6a965e8
@johnbillion
Partially update the database queries data schema.
6013937
@johnbillion
Build the schemas during the tests.
5b6077c
@johnbillion
These elements are optional.
e8589f7
@johnbillion
Replace the manual class comments with more schema definitions.
e0a956f
@johnbillion
Move this into a type for clarity.
0ba683f
@johnbillion
Fix up some more definitions for query data.
8055ee7
@johnbillion
Remove unnecessary manual typing.
b2633f3
@johnbillion
This property may not exist.
f758281
@johnbillion
This property may not exist.
b4b6f46
@johnbillion
Fix up the queried object data.
36b814f
@johnbillion johnbillion merged commit 36b814f into client-side-rendering Oct 17, 2023
0 of 30 checks passed
@johnbillion johnbillion deleted the json-schemas branch October 17, 2023 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@johnbillion